home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / ra / ratp23.zip / RATOP.DOC < prev    next >
Text File  |  1991-12-21  |  11KB  |  318 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                                RaTop v2.3
  4.  
  5.                 RemoteAccess Top Users Bulletin Generator
  6.  
  7.                  Copyright (C) 1990-91  Foxtrot Software
  8.                            All Rights Reserved.
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to copy and distribute RaTop as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US $10.00.
  16.  
  17.   b.  It is not modified or reverse engineered in any way.
  18.  
  19.   c.  You distribute this software along with all documentation and
  20.       registration forms unmodified.
  21.  
  22.   The Author hereby disclaims all warranties relating to this software,
  23. whether expressed or implied, including without limitation any implied
  24. warranties of merchantability or fitness for a particular purpose.  The
  25. author will not be liable for any special, incidental, consequenctial,
  26. indirect or simular damages due to loss of data or any other reason.  The
  27. user of this software bears all risk as to the quality  and performance
  28. of this software.
  29.  
  30. -------------------Now that we have that out of the way-----------------------
  31.  
  32.   If you have any comments or suggestions for improvement of this software,
  33. you can contact me at Info-Center BBS, data: (914)567-1814, 24 hours a
  34. day or leave Net-Mail @Fidonet 1:272/26, @Magnet 100:900/39.
  35.  
  36.   If you like this software, and decide to keep it on your system, then
  37. please register your copy.  Registration is US $8.00.  Please help support
  38. the shareware concept and development of even more quality utilities.
  39.  
  40. Thank you for your support.
  41.  
  42. ------------------------------------------------------------------------------
  43.  
  44. 1. Introduction.
  45.  
  46.    RaTop is a utility that will allow the Sysop of a RA BBS system to
  47. produce a TOP Users Bulletin that contains the TOP Callers, TOP
  48. Downloaders and TOP Uploaders by name and how many times they called,
  49. bytes downloaded and bytes Uploaded on your system.  
  50.  
  51.    A number of features allow you to create custom Top User bulletins for
  52. your system.  These features are:
  53.  
  54.    a) Full Ansi Color support.
  55.    b) Ability to limit the numbers of users inluded in the bulletin.
  56.       Range is from 10-64000.
  57.    c) Control who will show up by Security Levels.
  58.    d) Control who will show up by Security Flags.
  59.    e) Control who will show up by Group Number.
  60. *  f) Control who will show up by 'NoList' switch.
  61.    g) Choice of Sysop or no Sysop to be included.
  62. *  h) Use Handles instead of real names in bulletins.
  63.    i) Use of an alternate control file so that multiple bulletins
  64.       may be created and tailored to different user parameters/
  65.    j) Ascii & Ansi bulletins are created.
  66.  
  67. * New with v2.3.
  68.  
  69.  
  70.   RaTop uses the environment variable RA= to find your System Files.
  71. This is required because not all RA systems place their USERS.BBS along
  72. with the rest of the system files.  The CONFIG.RA file is used to verify
  73. your key and to find the pathnames to your USERS.BBS file.  If the
  74. environment variable is not set on your system, then RaTop must be run in 
  75. the same directory where the System files are located.
  76.  
  77. *Note:  Please make sure that all your PATHS that you have specified
  78.         in your system configuration are FULL Paths to all your RA
  79.         System files and Message Base Files.  For example, if you used
  80.         \RA\ or \RA\MESSAGES\ to specify the paths to these areas, then
  81.         RATop must be run from the same Disk Drive as your RA BBS is
  82.         set up on.  Since no Drive is specified here, RATop does not
  83.         check which drive it is currently on so the required files for
  84.         operation may not be found.
  85.  
  86.  
  87.   You can set the variable by using the DOS Command SET RA=C:\RA in your
  88. autoexec.bat startup file.  Please refer to the RA documentation for
  89. further information on regarding setup of System Paths and the use of
  90. the RA environment variable.
  91.  
  92.   The bulletins created by RATop are usually placed in same directory as 
  93. all other text files that you use, but this can be overridden in the 
  94. RATop control file. 
  95.  
  96.   This version of RaTop is for use with Remote Access V 1.0 and later
  97. releases.
  98.  
  99.  
  100.  
  101. 2.  Setup.
  102.  
  103.     The following outlines what commands to in the RATOP.CTL control
  104.     file and COLORS available to adjust to your liking.
  105.                                                       
  106.     a.  An Editor that will create text files, such as EDLIN, GALAXY,
  107.         or any Editor that will allow CR/LF combinations at the end of each
  108.         line has to be used.  Create the RATOP.CTL file in your RA BBS
  109.         directory where your Users.BBS and your CONFIG.RA files are if
  110.         the RA environment variable is set, the directory you will be
  111.         running RaTop from.  RATop has deafults for all keywords listed 
  112.         below.  When you wish to have a keyword disabled and the default
  113.         assumed, then place a semi-colon in front of that keyword or leave
  114.         it out entirely.  Enter the following information:
  115.  
  116. ;
  117. ; Path - Full pathname of where you want the bulletin put.  No extension
  118. ;        is placed on this pathname.  If this command isn't present, then
  119. ;        RaTop will assume BULLET01 only as the filename and place the
  120. ;        bulletins in your current directory.
  121. ;
  122. Path        D:\RA\Txtfiles\Bullet01
  123. ;
  124. ; Title - The Title you wish to have at the heading of the bulletin.
  125. ;         This can be anything you desire as long as it is 70 characters
  126. ;         or less.  If this command isn't present, then RaTop will assume:
  127. ;         'Noname BBS from Anytown, USA'
  128. ;
  129. Title       Info-Center BBS * Top Users Report
  130. ;
  131. ; Frame - This is the color you want the frame of the bulletin to be.
  132. ;
  133. Frame       3
  134. ;
  135. ; Title1 - This is the color you want the Title above to be.
  136. ;
  137. Title1      15
  138. ;
  139. ; Title2 - This is the color you want the Bulletin Heading to be.
  140. ;          The bulletin heading is:
  141. ;          'C A L L E R S   D O W N L O A D E R S   U L O A D E R S'
  142. ;
  143. Title2      10
  144. ;
  145. ; Users  - This is the color you want the users names to be.
  146. ;
  147. Users       14
  148. ;
  149. ; Group -  Include this Keyword only if you want certain user groups to
  150. ;          included in the bulletin.  Valid Group numbers are 0-255.
  151. ;          Default is to include ALL groups in the bulletin.
  152. ;
  153. Group 0
  154. ;
  155. ; ShowHidden - This keyword allows RATop to use users names/handles in the
  156. ;              Bulletins created.  Default is not to include these users
  157. ;              in the list.  
  158. ;
  159. ShowHidden
  160. ;
  161. ; HandlesOnly - This keyword will allow RATop to use only Handles instead
  162. ;               real names in the bulletins created.  Default is to use
  163. ;               real names.
  164. ;
  165. HandlesOnly
  166. ;
  167. ; Background - This is the color you want the bulletin background to be.
  168. ;
  169. Background  0
  170. ;
  171. ; Security - The lowest security level a user has to have before being included 
  172. ;            in the bulletin.  Max is 64000.
  173. ;
  174. SecurityLvl 5
  175. ;
  176. ; SecFlags - This works exactly like the flags work for RemoteAccess.
  177. ;            
  178. SecFlags    -------- -------- -------- --------
  179. ;
  180.  
  181.  
  182.     b.   Available Colors Codes:
  183.  
  184.                ________
  185.        0  Black         \
  186.        1  Blue           \
  187.        2  Green           \  BackGround or
  188.        3  Cyan             ---------------
  189.        4  Red             /  ForeGround
  190.        5  Magenta        /
  191.        6  Brown         /
  192.        7  LightGray ___/
  193.                 _______
  194.        8  Gray         \
  195.        9  LightBlue     \
  196.        10 LightGreen     \  Foreground Only
  197.        11 LightCyan       ------------------
  198.        12 LightRed       /
  199.        13 LightMagenta  /
  200.        14 Yellow       /
  201.        15 White ______/
  202.  
  203.  
  204.  
  205.     c.  How to run RaTop:
  206.  
  207.         Usage:  RaTop [-?] [-S] [{-U n}] [-?] [{-F CtlFile}]
  208.  
  209.         RaTop can be executed with any or none of the following arguments:
  210.  
  211.         [-S]         -  will tell RaTop to include the SysOp's name and
  212.                         number of Calls, Downloads and Uploads.  Default is not
  213.                         to include the SysOp in the Bulletin.
  214.  
  215.         [-U n]       -  will tell RaTop how many Users you wish to include
  216.                         in the Bulletin.  Default is The Top 20 Users.
  217.                         Valid numbers are from 10 - 64000.
  218.  
  219.         [-?]         -  will tell RaTop to display command line help.  If
  220.                         this argument is to be used, then it must be the only
  221.                         one used on the command line to recieve help.
  222.  
  223.         [-F CtlFile] -  will tell RaTop to use an alternate Control file
  224.                         to process.  This would allow you to create numerous
  225.                         bulletins using different security/flags settings.
  226.  
  227.  
  228.     d.  All that is needed now is, you to make sure that you have
  229.         RATOP.CTL in your current directory and then execute RATOP.EXE
  230.         it in that directory.  RATOP.EXE defaults to USERS.BBS and is
  231.         not configurable by you.
  232.  
  233.  
  234. 4.  Closing.
  235.  
  236.     I hope this little utility will help enhance your RA BBS as it
  237.     has mine.  I had fun writing it anyway.
  238.  
  239.  
  240.                      
  241. Other quality software available from me for SysOps:
  242.  
  243. Magic Name     Description
  244.  
  245. RAFBSTAT       Creates a bulletin with stats on all your files areas for
  246.                Remote Access v 1.0.
  247.  
  248. QUIKTOP        Creates a Top Users bulletin for QuickBBS 2.64.
  249.  
  250. OPUSTOP        Creates a Top Users bulletin for OPUS CBCS 1.1x.
  251.  
  252. RATOP          Creates a Top Users bulletin for RemoteAccess 1.01.
  253.  
  254.  
  255.  
  256. PROBLEMS:
  257.  
  258.    Please notify me immediately if you have any problems or
  259. suggestions about this program.  Enhancements are being incorporated
  260. all the time and your input is more vital to this process than you
  261. think.  You may write me, send Net-Mail or logon at the following address:
  262.  
  263. Byron Copeland (Sysop)               Info-Center BBS (formerly The
  264. 11 Y Street                              Foxtrot BBS, 1:360/11)
  265. New Windsor, NY 12553                (914) 567-1814 @Fidonet 1:272/26
  266.                                      24 hours, Every day!
  267.  
  268.  
  269. Authorized Distibution sites for Foxtrot Software:
  270.  
  271. Info-Center BBS   New Windsor, NY  (914) 567-1814
  272. The Outlaw BBS    Kennesaw, GA     (404) 590-1969
  273.  
  274.  
  275.                 Enjoy and thank you for your support.
  276.  
  277.  
  278.                               - End -
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317. 
  318.